feat: idempotent refunds - #1900
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolves issue by introducing durable idempotency support and atomic conflict handling for the postage refund endpoint (
POST /api/v1/postage/:messageId/refund).Problem
Refund and settlement requests can race or be retried after client timeouts or network disruptions. Without idempotency and atomic state transitions, retries could result in duplicate side-effects or ambiguous escrow states.
Changes Implemented
Refund Route Idempotency (
src/routes/api/v1/postage/$messageId/refund.ts):X-Idempotency-Keyheader handling.acquireIdempotencyto lease actor-scoped idempotency keys (scoped per recipient).200 OK) and terminal-state error responses (409 Conflict) with headerx-idempotency-replayed: true.in_progressconcurrency locks with a409 Conflicterror.recordIdempotency.Unit Tests (
tests/unit/api/postage-refund-idempotency.test.ts):409 Conflict) when refunding already-refunded or already-settled postage.checkIdempotencyandrecordIdempotency.Documentation:
docs/api/REFUND_IDEMPOTENCY.mdwith detailed API specifications, flow diagrams, error payload contracts, security/actor isolation rationale, and client implementation guidelines.docs/api/README.mdandsrc/routes/api/v1/postage/README.mdto referenceREFUND_IDEMPOTENCY.mdand the refund idempotency contract.Acceptance Criteria Verification
200 OKor409 Conflict).Fixes #1546